home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / Xm / XmDragIcon.z / XmDragIcon
Encoding:
Text File  |  2001-04-17  |  15.8 KB  |  265 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn((((3333XXXX))))            UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV            XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn - The DragIcon widget class
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           #include <Xm/DragDrop.h>
  13.  
  14.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  15.           This page documents Motif 2.1.
  16.  
  17.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.           A DragIcon is a component of the visual used to represent
  19.           the source data in a drag and drop transaction. During a
  20.           drag operation, a real or simulated X cursor provides drag-
  21.           over visuals consisting of a static portion that represents
  22.           the object being dragged, and dynamic cues that provide
  23.           visual feedback during the drag operation. The visual is
  24.           attained by blending together various _X_m_D_r_a_g_I_c_o_n_sspecified
  25.           in the XXXXmmmmDDDDrrrraaaaggggCCCCoooonnnntttteeeexxxxtttt associated with the drag operation.
  26.  
  27.           The static portion of the drag-over visual is the graphic
  28.           representation that identifies the drag source. For example,
  29.           when a user drags several items within a list, a DragIcon
  30.           depicting a list might be supplied as the visual. The
  31.           XXXXmmmmDDDDrrrraaaaggggCCCCoooonnnntttteeeexxxxttttresources, XXXXmmmmNNNNssssoooouuuurrrrcccceeeeCCCCuuuurrrrssssoooorrrrIIIIccccoooonnnn or
  32.           XXXXmmmmNNNNssssoooouuuurrrrcccceeeePPPPiiiixxxxmmmmaaaappppIIIIccccoooonnnn, specify a DragIcon to use for the
  33.           static portion of the visual.
  34.  
  35.           A drag-over visual incorporates dynamic cues in order to
  36.           provide visual feedback in response to the user's actions.
  37.           For instance, the drag-over visual might use different
  38.           indicators to identify the type of operation (copy, link, or
  39.           move) being performed. Dynamic cues could also alert the
  40.           user that a drop site is valid or invalid as the pointer
  41.           traverses the drop site. The XXXXmmmmNNNNooooppppeeeerrrraaaattttiiiioooonnnnCCCCuuuurrrrssssoooorrrrIIIIccccoooonnnnand
  42.           XXXXmmmmNNNNssssttttaaaatttteeeeCCCCuuuurrrrssssoooorrrrIIIIccccoooonnnn resources of XXXXmmmmDDDDrrrraaaaggggCCCCoooonnnntttteeeexxxxtttt specify
  43.           DragIcons for dynamic cues.
  44.  
  45.           A drag-over visual typically consists of a source, operation
  46.           and state DragIcon. The XXXXmmmmNNNNbbbblllleeeennnnddddMMMMooooddddeeeellll resource of
  47.           XXXXmmmmDDDDrrrraaaaggggCCCCoooonnnntttteeeexxxxttttoffers several options that determine which
  48.           icons are blended to produce the drag-over visual. DragIcon
  49.           resources control the relative position of the operation and
  50.           state icons (if used).  If a particular DragIcon is not
  51.           specified, the toolkit uses the XXXXmmmmSSSSccccrrrreeeeeeeennnn default DragIcons.
  52.  
  53.           An application initializes a DragIcon with the function
  54.           XXXXmmmmCCCCrrrreeeeaaaatttteeeeDDDDrrrraaaaggggIIIIccccoooonnnn or through entries in the resource
  55.           database. If a pixmap and its mask (optional) are specified
  56.           in the resource database, the toolkit converts the values in
  57.           the X11 Bitmap file format and assigns values to the
  58.           corresponding resources.
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                           (printed 4/6/01)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn((((3333XXXX))))            UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV            XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn((((3333XXXX))))
  71.  
  72.  
  73.  
  74.         CCCCllllaaaasssssssseeeessss
  75.           DragIcon inherits behavior and a resource from OOOObbbbjjjjeeeecccctttt.
  76.  
  77.           The class pointer is _x_m_D_r_a_g_I_c_o_n_O_b_j_e_c_t_C_l_a_s_s.
  78.  
  79.           The class name is XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn.
  80.  
  81.         NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
  82.           The following table defines a set of widget resources used
  83.           by the programmer to specify data. The programmer can also
  84.           set the resource values for the inherited classes to set
  85.           attributes for this widget. To reference a resource by name
  86.           or by class in a ....XXXXddddeeeeffffaaaauuuullllttttssss file, remove the XXXXmmmmNNNN or XXXXmmmmCCCC
  87.           prefix and use the remaining letters. To specify one of the
  88.           defined values for a resource in a ....XXXXddddeeeeffffaaaauuuullllttttssss file, remove
  89.           the XXXXmmmm prefix and use the remaining letters (in either
  90.           lowercase or uppercase, but include any underscores between
  91.           words). The codes in the access column indicate if the given
  92.           resource can be set at creation time (C), set by using
  93.           XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (S), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (G), or is
  94.           not applicable (N/A).
  95.  
  96.                                      XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  97.           NNNNaaaammmmeeee            CCCCllllaaaassssssss           TTTTyyyyppppeeee            DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  98.           XmNattachment   XmCAttachment   unsigned char   XmATTACH_NORTH_WEST    CSG
  99.           XmNdepth        XmCDepth        int             1                      CSG
  100.           XmNheight       XmCHeight       Dimension       0                      CSG
  101.           XmNhotX         XmCHot          Position        0                      CSG
  102.           XmNhotY         XmCHot          Position        0                      CSG
  103.           XmNmask         XmCPixmap       Pixmap          XmUNSPECIFIED_PIXMAP   CSG
  104.           XmNoffsetX      XmCOffset       Position        0                      CSG
  105.           XmNoffsetY      XmCOffset       Position        0                      CSG
  106.           XmNpixmap       XmCPixmap       Pixmap          XmUNSPECIFIED_PIXMAP   CSG
  107.           XmNwidth        XmCWidth        Dimension       0                      CSG
  108.  
  109.           XXXXmmmmNNNNaaaattttttttaaaacccchhhhmmmmeeeennnntttt
  110.                     Specifies a relative location on the source icon
  111.                     for the attachment of the state or operation icon.
  112.                     The origin of the state and operation icons is
  113.                     aligned with the specified compass point on the
  114.                     source icon.  The XXXXmmmmNNNNooooffffffffsssseeeettttXXXX and XXXXmmmmNNNNooooffffffffsssseeeettttYYYY
  115.                     resources can be used to further refine the icon
  116.                     positions. The possible values are
  117.  
  118.                     XXXXmmmmAAAATTTTTTTTAAAACCCCHHHH____NNNNOOOORRRRTTTTHHHH____WWWWEEEESSSSTTTT
  119.                               Attaches the origin of the state or
  120.                               operation icon to the northwest point on
  121.                               the source icon.
  122.  
  123.                     XXXXmmmmAAAATTTTTTTTAAAACCCCHHHH____NNNNOOOORRRRTTTTHHHH
  124.                               Attaches the origin of the state or
  125.                               operation icon to the north point on the
  126.  
  127.  
  128.  
  129.      Page 2                                           (printed 4/6/01)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn((((3333XXXX))))            UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV            XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn((((3333XXXX))))
  137.  
  138.  
  139.  
  140.                               source icon.
  141.  
  142.                     XXXXmmmmAAAATTTTTTTTAAAACCCCHHHH____NNNNOOOORRRRTTTTHHHH____EEEEAAAASSSSTTTT
  143.                               Attaches the origin of the state or
  144.                               operation icon to the northeast point on
  145.                               the source icon.
  146.  
  147.                     XXXXmmmmAAAATTTTTTTTAAAACCCCHHHH____EEEEAAAASSSSTTTT
  148.                               Attaches the origin of the state or
  149.                               operation icon to the east point on the
  150.                               source icon.
  151.  
  152.                     XXXXmmmmAAAATTTTTTTTAAAACCCCHHHH____SSSSOOOOUUUUTTTTHHHH____EEEEAAAASSSSTTTT
  153.                               Attaches the origin of the state or
  154.                               operation icon to the southeast point on
  155.                               the source icon.
  156.  
  157.                     XXXXmmmmAAAATTTTTTTTAAAACCCCHHHH____SSSSOOOOUUUUTTTTHHHH
  158.                               Attaches the origin of the state or
  159.                               operation icon to the south point on the
  160.                               source icon.
  161.  
  162.                     XXXXmmmmAAAATTTTTTTTAAAACCCCHHHH____SSSSOOOOUUUUTTTTHHHH____WWWWEEEESSSSTTTT
  163.                               Attaches the origin of the state or
  164.                               operation icon to the southwest point on
  165.                               the source icon.
  166.  
  167.                     XXXXmmmmAAAATTTTTTTTAAAACCCCHHHH____WWWWEEEESSSSTTTT
  168.                               Attaches the origin of the state or
  169.                               operation icon to the west point on the
  170.                               source icon.
  171.  
  172.                     XXXXmmmmAAAATTTTTTTTAAAACCCCHHHH____CCCCEEEENNNNTTTTEEEERRRR
  173.                               Attaches the origin of the state or
  174.                               operation icon to the center of the
  175.                               source icon. The XXXXmmmmNNNNooooffffffffsssseeeettttXXXX and
  176.                               XXXXmmmmNNNNooooffffffffsssseeeettttYYYYresources may be used to
  177.                               center the attached icon.
  178.  
  179.                     XXXXmmmmAAAATTTTTTTTAAAACCCCHHHH____HHHHOOOOTTTT
  180.                               Attaches the hotspot coordinates of a
  181.                               state or operation DragIcon to an x,y
  182.                               position on the source icon. The x,y
  183.                               coordinate is taken from the event
  184.                               passed to the XXXXmmmmDDDDrrrraaaaggggSSSSttttaaaarrrrtttt function, and
  185.                               made relative to the widget passed as an
  186.                               argument to the same function.
  187.  
  188.           XXXXmmmmNNNNddddeeeepppptttthhhh  Specifies the depth of the pixmap.
  189.  
  190.           XXXXmmmmNNNNhhhheeeeiiiigggghhhhtttt Specifies the height of the pixmap.
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                           (printed 4/6/01)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn((((3333XXXX))))            UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV            XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn((((3333XXXX))))
  203.  
  204.  
  205.  
  206.           XXXXmmmmNNNNhhhhoooottttXXXX   Specifies the x-coordinate of the hotspot of a
  207.                     cursor DragIcon in relation to the origin of the
  208.                     pixmap bounding box.
  209.  
  210.           XXXXmmmmNNNNhhhhoooottttYYYY   Specifies the y-coordinate of the hotspot of a
  211.                     cursor DragIcon in relation to the origin of the
  212.                     pixmap bounding box.
  213.  
  214.           XXXXmmmmNNNNmmmmaaaasssskkkk   Specifies a pixmap of depth 1 to use as the
  215.                     DragIcon mask pixmap.
  216.  
  217.           XXXXmmmmNNNNooooffffffffsssseeeettttXXXX
  218.                     Specifies a horizontal offset (in pixels) of the
  219.                     origin of the state or operation icon relative to
  220.                     the attachment point on the source icon.  A
  221.                     positive offset value moves the origin to the
  222.                     right; a negative value moves the origin to the
  223.                     left.
  224.  
  225.           XXXXmmmmNNNNooooffffffffsssseeeettttYYYY
  226.                     Specifies a vertical offset (in pixels) of the
  227.                     origin of the state or operation icon relative to
  228.                     the attachment point on the source icon. A
  229.                     positive offset value moves the origin down; a
  230.                     negative value moves the origin up.
  231.  
  232.           XXXXmmmmNNNNppppiiiixxxxmmmmaaaapppp Specifies a pixmap to use as the DragIcon pixmap.
  233.  
  234.           XXXXmmmmNNNNwwwwiiiiddddtttthhhh  Specifies the width of the pixmap.
  235.  
  236.         IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
  237.           DragIcon inherits behavior and a resource from OOOObbbbjjjjeeeecccctttt.  For
  238.           a complete description of this resource, refer to the OOOObbbbjjjjeeeecccctttt
  239.           reference page.
  240.  
  241.                                   OOOObbbbjjjjeeeecccctttt RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  242.           NNNNaaaammmmeeee                 CCCCllllaaaassssssss         TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  243.           XmNdestroyCallback   XmCCallback   XtCallbackList   NULL      C
  244.  
  245.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  246.           OOOObbbbjjjjeeeecccctttt(3), XXXXmmmmCCCCrrrreeeeaaaatttteeeeDDDDrrrraaaaggggIIIIccccoooonnnn(3), XXXXmmmmDDDDiiiissssppppllllaaaayyyy(3),
  247.           XXXXmmmmDDDDrrrraaaaggggCCCCoooonnnntttteeeexxxxtttt(3), XXXXmmmmDDDDrrrrooooppppSSSSiiiitttteeee(3), XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrr(3), and
  248.           XXXXmmmmSSSSccccrrrreeeeeeeennnn(3).
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                           (printed 4/6/01)
  262.  
  263.  
  264.  
  265.